

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>cup.storage package &mdash; cup 1.7.0 documentation</title>
  

  
  
  
  

  

  
  
    

  

  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex/" />
    <link rel="search" title="Search" href="../search/" />
    <link rel="next" title="cup.jenkinslib package" href="../cup.jenkinslib/" />
    <link rel="prev" title="cup.shell package" href="../cup.shell/" /> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../" class="icon icon-home"> cup
          

          
          </a>

          
            
            
              <div class="version">
                1.7
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../cup/">cup package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../cup/#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../cup.net/">cup.net package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cup.res/">cup.res package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cup.util/">cup.util package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cup.services/">cup.services package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cup.shell/">cup.shell package</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">cup.storage package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-cup.storage.obj">cup.storage.obj module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-cup.storage">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../cup.jenkinslib/">cup.jenkinslib package</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cup.web/">cup.web package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.cache">cup.cache module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.const">cup.const module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.decorators">cup.decorators module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.err">cup.err module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.exfile">cup.exfile module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.flag">cup.flag module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.log">cup.log module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.mail">cup.mail module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.platforms">cup.platforms module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.thread">cup.thread module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.timeplus">cup.timeplus module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.unittest">cup.unittest module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup.version">cup.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cup/#module-cup">Module contents</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../">cup</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../">Docs</a> &raquo;</li>
        
          <li><a href="../cup/">cup package</a> &raquo;</li>
        
      <li>cup.storage package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/cup.storage.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="cup-storage-package">
<h1>cup.storage package<a class="headerlink" href="#cup-storage-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-cup.storage.obj">
<span id="cup-storage-obj-module"></span><h2>cup.storage.obj module<a class="headerlink" href="#module-cup.storage.obj" title="Permalink to this headline">¶</a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">description:</th><td class="field-body">Object related storage</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="cup.storage.obj.AFSObjectSystem">
<em class="property">class </em><code class="descclassname">cup.storage.obj.</code><code class="descname">AFSObjectSystem</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">cup.storage.obj.ObjectInterface</span></code></p>
<p>afs object</p>
<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>delete a file</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – object path</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>{</dt>
<dd>‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</dd>
</dl>
<p>}</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>path</em>, <em>localpath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.get" title="Permalink to this definition">¶</a></dt>
<dd><p>get the object into localpath
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd>‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.head">
<code class="descname">head</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.head" title="Permalink to this definition">¶</a></dt>
<dd><p>get the object info
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd><p class="first">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’
‘objectinfo’: {</p>
<blockquote>
<div></div></blockquote>
<p class="last">}</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.mkdir">
<code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.mkdir" title="Permalink to this definition">¶</a></dt>
<dd><p>mkdir dir of a path
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd><p class="first">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’
‘objectinfo’: {</p>
<blockquote>
<div></div></blockquote>
<p class="last">}</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.put">
<code class="descname">put</code><span class="sig-paren">(</span><em>dest</em>, <em>localfile</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.put" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>dest</strong> – system path</li>
<li><strong>localfile</strong> – localfile</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
<dt>{</dt>
<dd><p class="first last">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</p>
</dd>
</dl>
<p>}</p>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.AFSObjectSystem.rmdir">
<code class="descname">rmdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#AFSObjectSystem.rmdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.AFSObjectSystem.rmdir" title="Permalink to this definition">¶</a></dt>
<dd><p>rmdir of a path</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="cup.storage.obj.S3ObjectSystem">
<em class="property">class </em><code class="descclassname">cup.storage.obj.</code><code class="descname">S3ObjectSystem</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">cup.storage.obj.ObjectInterface</span></code></p>
<p>s3 object system</p>
<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.create_bucket">
<code class="descname">create_bucket</code><span class="sig-paren">(</span><em>bucket_name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.create_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.create_bucket" title="Permalink to this definition">¶</a></dt>
<dd><p>create bucket</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>delete a file</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – object path</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>{</dt>
<dd>‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</dd>
</dl>
<p>}</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.delete_bucket">
<code class="descname">delete_bucket</code><span class="sig-paren">(</span><em>bucket_name</em>, <em>forcely=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.delete_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.delete_bucket" title="Permalink to this definition">¶</a></dt>
<dd><p>delete bucket</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>forcely</strong> – <dl class="docutils">
<dt>if forcely is True, the bucket will be delete no matter it has</dt>
<dd>objects inside. Otherwise, you have to delete items inside,
then delete the bucket</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>path</em>, <em>localpath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.get" title="Permalink to this definition">¶</a></dt>
<dd><p>get the object into localpath
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd>‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.head">
<code class="descname">head</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.head" title="Permalink to this definition">¶</a></dt>
<dd><p>get the object info
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd><p class="first">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’
‘objectinfo’: {</p>
<blockquote>
<div></div></blockquote>
<p class="last">}</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.head_bucket">
<code class="descname">head_bucket</code><span class="sig-paren">(</span><em>bucket_name</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.head_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.head_bucket" title="Permalink to this definition">¶</a></dt>
<dd><p>create bucket</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.mkdir">
<code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.mkdir" title="Permalink to this definition">¶</a></dt>
<dd><p>mkdir dir of a path
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd><p class="first">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’
‘objectinfo’: {</p>
<blockquote>
<div></div></blockquote>
<p class="last">}</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.put">
<code class="descname">put</code><span class="sig-paren">(</span><em>dest</em>, <em>localfile</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.put" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>dest</strong> – system path</li>
<li><strong>localfile</strong> – localfile</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
<dt>{</dt>
<dd><p class="first last">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’</p>
</dd>
</dl>
<p>}</p>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.S3ObjectSystem.rmdir">
<code class="descname">rmdir</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#S3ObjectSystem.rmdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.S3ObjectSystem.rmdir" title="Permalink to this definition">¶</a></dt>
<dd><p>rmdir of a path</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="cup.storage.obj.FTPObjectSystem">
<em class="property">class </em><code class="descclassname">cup.storage.obj.</code><code class="descname">FTPObjectSystem</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">cup.storage.obj.ObjectInterface</span></code></p>
<p>ftp object system</p>
<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>delete file</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>path</em>, <em>localpath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.get" title="Permalink to this definition">¶</a></dt>
<dd><p>get a file into localpath</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.head">
<code class="descname">head</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.head" title="Permalink to this definition">¶</a></dt>
<dd><p>get the file info
:return:</p>
<blockquote>
<div><dl class="docutils">
<dt>{</dt>
<dd><p class="first">‘returncode’: 0 for success, others for failure,
‘msg’: ‘if any’
‘fileinfo’: [</p>
<blockquote>
<div>“-rw-rw-r– 1 work work   201 Nov  9 17:03 __init__.py”</div></blockquote>
<p class="last">[</p>
</dd>
</dl>
<p>}</p>
</div></blockquote>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.is_file">
<code class="descname">is_file</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.is_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.is_file" title="Permalink to this definition">¶</a></dt>
<dd><p>path is file or not</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.mkdir">
<code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.mkdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.put">
<code class="descname">put</code><span class="sig-paren">(</span><em>dest</em>, <em>localfile</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.put" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>dest</strong> – ftp path</li>
<li><strong>localfile</strong> – localfile</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.FTPObjectSystem.rmdir">
<code class="descname">rmdir</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#FTPObjectSystem.rmdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.FTPObjectSystem.rmdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="cup.storage.obj.LocalObjectSystem">
<em class="property">class </em><code class="descclassname">cup.storage.obj.</code><code class="descname">LocalObjectSystem</code><span class="sig-paren">(</span><em>kvconfig=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">cup.storage.obj.ObjectInterface</span></code></p>
<p>local object system</p>
<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.delete">
<code class="descname">delete</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>delete a file in local</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>path</em>, <em>localpath</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.get" title="Permalink to this definition">¶</a></dt>
<dd><p>get a file into localpath</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.head">
<code class="descname">head</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.head"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.head" title="Permalink to this definition">¶</a></dt>
<dd><p>get the object info</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.mkdir">
<code class="descname">mkdir</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.mkdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.mkdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.put">
<code class="descname">put</code><span class="sig-paren">(</span><em>dest</em>, <em>localfile</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.put" title="Permalink to this definition">¶</a></dt>
<dd><p>local object put == copy</p>
</dd></dl>

<dl class="method">
<dt id="cup.storage.obj.LocalObjectSystem.rmdir">
<code class="descname">rmdir</code><span class="sig-paren">(</span><em>path</em>, <em>recursive=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/cup/storage/obj/#LocalObjectSystem.rmdir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cup.storage.obj.LocalObjectSystem.rmdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-cup.storage">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cup.storage" title="Permalink to this headline">¶</a></h2>
<p>init for cup.storage</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../cup.jenkinslib/" class="btn btn-neutral float-right" title="cup.jenkinslib package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="../cup.shell/" class="btn btn-neutral" title="cup.shell package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, CUP-DEV.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'1.7.0',
            LANGUAGE:'en',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  <script type="text/javascript" src="../_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>